6.8 查询外部组织架构详情(包含子组详情)

基本信息

Path: /api/v1/externalUserGroup/queryAll

Method: GET

接口描述:

  1. 查询的组织架构会包含所有直接的子组,可以通过递归调用该接口构建完整的组织架构树
  2. isImported为0的组织架构为未导入组织架构,数据是虚构的,单纯是为了构建树形结构而插入,如果hasChild为1,可以拿fullpath字段来查询它的子组
  3. 组织架构hasChild为0,表示没有子组,分支递归中止
  4. 注意该接口不返回关联的角色列表

请求参数

Query

注意:

  1. path字段包含斜杠,发送前请转成URL编码%2F
参数名称 是否必须 示例 备注
path 必须 / 组织架构路径
userDirectoryId 与userDirectoryName二选一 所属用户目录ID userDirectoryId和userDirectoryName只传一个即可,都传时以userDirectoryId为准
userDirectoryName 与userDirectoryId二选一 所属用户目录名称 >=2.3.6版本开始支持。userDirectoryId和userDirectoryName只传一个即可,都传时以userDirectoryId为准
  1. 如果响应状态码为401且控制台【审计中心/设备安全日志】中存在接口攻击行为日志,处置原因为[SNORT]SNORT ACTION: BLOCK。说明是设备检测到了请求中存在攻击特征,触发了自动拦截。请检查name或者userDirectoryName参数中是否存在SQL或命令注入特征,如select、delete等关键字,如果存在请修改组织架构名或者用户目录名称后重试。如需协助,可联系深信服客户服务热线:400-630-6430。

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code string 必须 错误码,非0表示失败
data object 必须 返回数据
├─ id string 必须 组织架构ID
├─ name string 必须 组织架构名字
├─ authComposeId string 必须 认证策略ID
├─ authComposeName string 必须 认证策略名称
├─ path string 必须 所属组织架构
├─ fullpath string 必须 组织架构全路径
├─ status string 必须 启用状态:0禁用,1启用
├─ expiredTime string 必须 过期时间,时间戳,13位长度,单位毫秒,'0'表示永不过期
├─ description string 必须 描述
├─ userPolicyId string 必须 用户策略ID
├─ description string 必须 组织架构描述信息
├─ hasChild number 必须 是否有子组,0没有,1有
├─ isDeleted number 必须 是否在外部服务器上已经删除,0不是,1是
├─ children object[] 必须 子组
├─├─ id string 必须 组ID
├─├─ name string 必须 组名
├─├─ path string 必须 所属组路径
├─├─ fullpath string 必须 组织架构全路径
├─├─ hasChild number 必须 是否有子组,0没有,1有
├─├─ isImported number 必须 是否已经导入本地,0不是,1是
msg string 必须 错误消息  

返回示例

{
    "code": 0,
    "data": {
        "id": "bc4469f0-e273-11ed-a6fd-ad21d94905f3",
        "isDeleted": 0,
        "name": "/",
        "path": "",
        "authComposeId": "",
        "userPolicyId": "",
        "userDirectoryId": "eac057e0-e26d-11ed-a6fd-ad21d94905f3",
        "description": "",
        "fullPath": "/",
        "isImported": 1,
        "children": [
            {
                "id": "bc4469fb-e273-11ed-a6fd-ad21d94905f3",
                "isDeleted": 0,
                "name": "Domain Controllers",
                "path": "/",
                "authComposeId": "",
                "userPolicyId": "",
                "userDirectoryId": "eac057e0-e26d-11ed-a6fd-ad21d94905f3",
                "description": "Default container for domain controllers",
                "fullPath": "/Domain Controllers",
                "isImported": 1,
                "hasChild": 0
            },
            {
                "id": "5b42a740-1ba6-11ee-afec-cb74441739ae",
                "name": "perf_user",
                "path": "/",
                "fullPath": "/perf_user",
                "isImported": 0,
                "hasChild": 1
            }
        ],
        "hasChild": 1
    },
    "msg": "请求成功",
    "traceId": "0166d1bce5dc037a"
}

错误信息

错误提示 错误码
请输入用户目录ID 7201
参数检查出错 10000001
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-09-05 14:20

results matching ""

    No results matching ""